feat: added deployment modes section #4731
Conversation
Added info about automatic and manual deployments to both sites
|
Your Platform.sh environment has successfully deployed. 🚀 See the changed pages: Platform.sh docs |
Adjusted docs according to github comments
made changes suggested in Slack
https://github.com/platformsh/platformsh-docs into 4730-document-the-automaticmanual-deployments-feature
fixed typo
made changes from veronika
added CLI output
removed spaces
added missing word
https://github.com/platformsh/platformsh-docs into 4730-document-the-automaticmanual-deployments-feature
Co-authored-by: David Bonachera <[email protected]>
made suggested edits
https://github.com/platformsh/platformsh-docs into 4730-document-the-automaticmanual-deployments-feature
added extra command
added subscription to table on upsun docs
|
|
||
| ### Automatic deployment (default) | ||
|
|
||
| This is the default behavior for all environments. With automatic deployment, changes like code pushes and variable updates are deployed immediately. This type of deployment is best suited for rapid iteration during development. |
There was a problem hiding this comment.
I'm not sure about the last sentence.
There was a problem hiding this comment.
Why exactly? How would you change that?
There was a problem hiding this comment.
Seems wrong especially since manual deployments can't actually be enabled on dev environments but only production and staging. So it's more during the initial setup.
There was a problem hiding this comment.
Here we are talking about "Automatic deployment", which is the default behavior. Not manual dpeloyment.
|
|
||
| ### Change deployment type | ||
|
|
||
| You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and select the manual deployments option. |
There was a problem hiding this comment.
We need to also show how to do it via the CLI and API.
There was a problem hiding this comment.
The CLI command is several blocks below.
For the API I'm not sure what's the common practice, I feel this page is quite extensive already.
There was a problem hiding this comment.
I would not add the API in there indeed. I'll add a link for the CLI below
There was a problem hiding this comment.
has_staged_activities is not writable, it's just a helper for the frontend
use upsun environment:deploy:type
There was a problem hiding this comment.
Hi @gmoigneu @vitolkachova we already have the upsun environment:deploy:type and platform environment:deploy:type commands in the docs. Is there anything outstanding surrounding this issue? We also have a tab that addresses how to do this via the API too.
There was a problem hiding this comment.
Well we have a "Change deployment type" where we mention the setting can be changed in the Console. We show the CLI command in the section below, which it's not exactly accurate
There was a problem hiding this comment.
Thanks @vitolkachova! I was under the impression that the CLI commands were accurate. @davidbonachera could you please let me know if there is something that needs to be changed regarding how users change deployment type via the CLI? It looks like this is the one outstanding thing that needs clarifying before we can merge :)
There was a problem hiding this comment.
The commands themselves are alright, but the placing might be misleading, otherwise this thread would not be started initially.
Added info about automatic and manual deployments to both sites
Why
Closes #4730
What's changed
/learn/overview/build-deploy.html#automatic-deployment-default now has a deployment modes section.
Where are changes
Updates are for:
sites/platformtemplates)sites/upsuntemplates)